CLI by gustavo-shigueo · Pull Request #400 · Aleph-Alpha/ts-rs

gustavo-shigueo · 2025-04-05T19:12:26Z

I'm copying the original cli PR into a new one for a couple of reasons:

The thread on the old one is VERY long and is getting hard to follow
Whoever is using the account that opened that PR (if anyone) probably doesn't wanna receive notifications about it

Closes #133
Closes #54
Closes #408

Todo

Find a way to only run ts-rs tests through this CLI
- Done by gating the generation of tests
  - Added a feature flag called export to ts-rs that re-enables test generation.
  - This feature is always enabled when using this CLI
Explore a way of generating an index.ts file to reexport all the generated types
- During export, generate a metadata file to list all types and where they are exported to
  - In the CLI, use the metadata file to create the index.ts file
  - Gate the generation of this file behind a feature flag named generate-metadata
A configuration file so the user doesn't have to pass the flags every time
- Add config flag to pass the path to the file?
- Add init subcommand to help create the config file
Discuss other features of the CLI
When we consider it ready, it would be interesting to also make it available through cargo binstall

Feature wishlist

Customize representations (e.g number vs bigint) (@NyxCode) (being worked on in proof-of-concept of type overrides using the CLI #334)
Load configuration from configfile (@NyxCode) (being worked on in proof-of-concept of type overrides using the CLI #334)
(maybe) Combine multiple types in one file? (@NyxCode) (feat: Allow multiple types to set #[ts(export_to = "...")] to the same file #316)
(maybe) generate index.ts file, re-exporting types (@NyxCode) (See explanation above)

Checklist

I have followed the steps listed in the Contributing guide.
If necessary, I have added documentation related to the changes made.
I have added or updated the tests related to the changes made.

gustavo-shigueo · 2025-04-05T19:53:53Z

cli/src/args.rs

+    /// Generates only a single index.ts file in your --output-directory that
+    /// contains all exported types
+    #[arg(long = "merge")]
+    pub merge_files: bool,


I believe that the combination of #316 and #399 has made this flag obsolete, as the user can create a const and use it on all export_to attributes to get the same effect

gustavo-shigueo · 2025-04-05T21:24:13Z

The implementation of the CLI is a breaking change for anyone who uses --no-default-features to disable serde-compat as that will also disable the new export feature, preventing the test functions that export the types from being generated

gustavo-shigueo · 2025-04-05T22:05:27Z

Hey @NyxCode, I merged #334 into the CLI and added a command to generate a default config file. I also removed the --merge flag, as I believe that #316 already does that well enough, especially when combined with #399.

What do you think of the current state of the CLI? Are there other features you want to include?

gustavo-shigueo · 2025-04-10T22:07:16Z

cli/src/config.rs

+            no_warnings: self.no_warnings || other.no_warnings,
+            esm_imports: self.esm_imports || other.esm_imports,
+            format: self.format || other.format,
+            generate_index_ts: self.generate_index_ts || other.generate_index_ts,
+            no_capture: self.no_capture || other.no_capture,


I'm thinking this isn't proper behavior for merging booleans when it comes to CLI vs Config file. I think the CLI should override the config file, but if the config file has no_warnings=true and the CLI has --no-warnings=false the config file would win due to the OR operator. Maybe the flags should be Option<bool> so the merging would look like self.no_warnings.or(other.no_warnings), then, instead of if args.no_warnings { /*...*/ }, we'd have if args.no_warnings == Some(true) { /*...*/ } (or is_some_and(|x| x) or unwrap_or(false), etc)

CriusNyx · 2025-06-21T19:43:54Z

Is there some work that I could contribute to this to help this PR get merged? I'm needing a way to generate barrel files (those index.ts files that reexport everything).

PS: NyxCode. Nice name. :3

gustavo-shigueo · 2025-06-22T00:33:36Z

Hello @CriusNyx , I'm not quite sure if/when this might be merged, as there are a few possible concerns about it:

@NyxCode has raised some concerns in Coordinate macro invocations #382
This PR is a breaking change for anyone using --no-default-features to disable serde-compat
We are not yet sure if there are more features we want to add
We haven't documented or tested the CLI very thoroughly yet - we did have someone use it and report good results in Feature request: export all types from a single entry point #408 though

All that being said, you can install it with the following command:
cargo install --git https://github.com/Aleph-Alpha/ts-rs --branch feat/cli ts-rs-cli and then use a ts-rs export --index to achieve the behavior you need

gustavo-shigueo · 2025-12-26T11:30:58Z

Hey @NyxCode, what do you think about merging this into the next branch (or main after we merge next)? We just had someone make another PR (#459) about not wanting cargo test to emit the types unless explicitly asked to and their implementation was pretty similar to what this PR is doing (feature flag, enabled by default which, when disabled, does not emit the types. Then running cargo test export_bindings_ with the feature flag) with major difference being that the cargo test command would still be written manually

gustavo-shigueo added 3 commits April 5, 2025 16:09

Copy over changes from cli branch

3fa748b

Make export a default feature

cfa24b2

Fix clippy warnings

f568dea

gustavo-shigueo commented Apr 5, 2025

View reviewed changes

NyxCode and others added 5 commits April 5, 2025 17:26

proof-of-concept of type overrides using the CLI (#334)

3ee5fed

Fix line endings

292c75e

Remove type duplication between Args and config

3c0acc8

Simplify load_from_file

045dc88

Remove merge flag

b83a888

gustavo-shigueo added CLI This issue/PR is related to or requires the implementation of the CLI tool breaking change This PR will change the public API in some way labels Apr 5, 2025

gustavo-shigueo added 2 commits April 5, 2025 18:51

Add init command to generate default config file

ca32539

Document subcommands

c22bc1a

gustavo-shigueo requested a review from NyxCode April 5, 2025 21:58

gustavo-shigueo added 4 commits April 5, 2025 19:08

Rename the binary to ts-rs

cea32cc

Set workspace root as default config file path

658cf88

Add ts-rs.toml to .gitignore

d767438

Rename metadata file to ts-rs.meta for consistency

ec64744

This comment has been minimized.

Sign in to view

gustavo-shigueo commented Apr 10, 2025

View reviewed changes

gustavo-shigueo mentioned this pull request May 9, 2025

Use Option for proper argument merging #402

Merged

Use Option for proper argument merging (#402)

39d4873

gustavo-shigueo added 2 commits October 17, 2025 09:42

Merge branch 'main' into feat/cli

e287fe3

Merge branch 'main' into feat/cli

e493614

gustavo-shigueo mentioned this pull request Dec 23, 2025

opt out of automatic export of bindings #459

Closed

3 tasks

Merge branch 'main' into feat/cli

68e91bd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLI#400

CLI#400
gustavo-shigueo wants to merge 18 commits intomainfrom
feat/cli

gustavo-shigueo commented Apr 5, 2025 •

edited

Loading

Uh oh!

gustavo-shigueo Apr 5, 2025

Uh oh!

gustavo-shigueo commented Apr 5, 2025

Uh oh!

gustavo-shigueo commented Apr 5, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

gustavo-shigueo Apr 10, 2025

Uh oh!

CriusNyx commented Jun 21, 2025

Uh oh!

gustavo-shigueo commented Jun 22, 2025 •

edited

Loading

Uh oh!

gustavo-shigueo commented Dec 26, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

gustavo-shigueo commented Apr 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Todo

Feature wishlist

Checklist

Uh oh!

gustavo-shigueo Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

gustavo-shigueo commented Apr 5, 2025

Uh oh!

gustavo-shigueo commented Apr 5, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

gustavo-shigueo Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

CriusNyx commented Jun 21, 2025

Uh oh!

gustavo-shigueo commented Jun 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gustavo-shigueo commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gustavo-shigueo commented Apr 5, 2025 •

edited

Loading

gustavo-shigueo commented Jun 22, 2025 •

edited

Loading

gustavo-shigueo commented Dec 26, 2025 •

edited

Loading